docs: add a runnable chat room example - #184
Conversation
|
Warning Review limit reached
Next review available in: 41 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (7)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
the
documentation
cf67d20 to
5963cb9
Compare
1 participant
Summary
Adds
examples/, outside the published package, with the minimal chat room from #113. One room, two clients, one broadcast, plus an example README saying what it demonstrates.examples/*joins the pnpm workspace so the example resolvessmocketby workspace link, andpnpm example:chat-roombuilds and runs it in one command.Verified from a clean clone:
pnpm install --frozen-lockfilethenpnpm example:chat-roomprints the output the example README quotes, and it is stable across runs because both joins are acknowledged before anyone speaks.The larger application example in #113 is not here. It is recovered from the dogfooding application, which does not exist yet, and so are the browser sandbox link and the scaffolding command that reach these files.
Related issue
Part of #113
Checklist